home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / edit / mg2a_src.zip / SYS / VMS / AAAREADM.1ST next >
Text File  |  1988-08-23  |  6KB  |  151 lines
  1. This directory ([.SYS.VMS]) contains the VMS-specific files for MG.
  2.  
  3.             +-----------------------+
  4.             |      Construction    |
  5.             +-----------------------+
  6.  
  7. By this point you should have put the ``system-independent'' files
  8. into a directory of your choice, then put the VMS files into the
  9. subdirectory [.SYS.VMS].  You should also put the termcap terminal
  10. driver into the subdirectory [.SYS.DEFAULT], and the termcap library
  11. files into [.SYS.TERMLIB].  These come with the standard MG distribution, 
  12. so you shouldn't have much trouble.
  13.  
  14. The command file MAKE.COM is designed to compile and link the entire
  15. program, using the VMS system functions and the termcap terminal
  16. driver.
  17.  
  18. To invoke MAKE.COM, enter
  19.  
  20.     SET DEF dev:[emacs-dir]    ! location of system-independent files
  21.     @[.SYS.VMS]MAKE        ! go have some coffee...
  22.  
  23. This will create the termcap library, compile each of the necessary
  24. modules, and link the entire program into dev:[emacs-dir]MG.EXE.
  25.  
  26. NOTE: To keep the size of the executable program down, MAKE.COM
  27. attempts to link in the VAX C shareable run-time library. Since VMS
  28. 4.4 and up have the VAX C run-time library bundled into it, there
  29. shouldn't be any problem finding it.  If there is, modify MG.OPT to
  30. link with SYS$LIBRARY:VAXCRTL.OBJ/LIB instead. 
  31.  
  32.     +-------------------------------------------------------+
  33.     |    Specifying Your Terminal With Termcap        |
  34.     +-------------------------------------------------------+
  35.  
  36. (CAVEAT AND CREDITS: The termcap subroutine library in
  37. [.SYS.TERMLIB] was written by Fred Fish (of Amiga Public Domain
  38. Library fame) and placed in the public domain. It is not guaranteed to
  39. be a complete implementation of the Unix termcap(5) library; the usual
  40. disclaimers (like "it works for me":-) apply here.  I have modified it
  41. to support the tc= capability, which lets you define terminals in
  42. terms (pardon the pun) of other terminals, so it should work
  43. reasonably well with the termcap provided in [.SYS.TERMLIB]TERMCAP.)
  44.  
  45. To use the termcap library, you need to tell it where to find a
  46. terminal definition (termcap) file.  If you have GNU Emacs installed,
  47. MG will use its termcap file from EMACS_LIBRARY:[ETC]TERMCAP.DAT.
  48. Otherwise, it will try to find the file which on Unix systems is
  49. called /etc/termcap.  To emulate the same behavior on VMS, DEFINE/JOB
  50. the logical name ETC to point to a directory that contains a termcap
  51. file, with the name TERMCAP. (no extension). (The /JOB qualifier is
  52. needed when you run MG as a spawned supprocess.)
  53.  
  54.     DEFINE/JOB ETC dev:[dir]
  55.  
  56. If your system has Eunice, there is a large termcap file already
  57. available via this exact mechanism, so you shouldn't need to define
  58. ETC at all.  If you don't have Eunice, never fear; a termcap resides
  59. in the file [.SYS.TERMLIB]TERMCAP., so all you have to do is
  60.  
  61.     DEFINE ETC [emacs-directory.SYS.TERMLIB]
  62.  
  63. to get started.  You get the idea.  Lastly, if your site uses the
  64. logical name ETC for another purpose, you can define the logical name
  65. TERMCAP to point to the MG termcap file.  You must specify the path in
  66. Unix format, with the root being the disk drive the file resides on.
  67. For example, if the termcap file is in DUA0:[USER]TERMCAP., the
  68. command would be
  69.  
  70.     DEFINE TERMCAP "/dua0/user/termcap"
  71.  
  72. The VAX C run-time library can translate this into the appropriate VMS
  73. file specification for you (a rather nice feature...).
  74.  
  75. Once you've indicated where the termcap file is, you can tell MG what
  76. kind of terminal you're using by defining the logical name EMACS_TERM.
  77.  
  78.     DEFINE/JOB EMACS_TERM "termtype"
  79.  
  80. where "termtype" is in lower case and matches an entry in the termcap
  81. file.  (Alternatively, you can define the logical name TERM and MG will
  82. look there if EMACS_TERM is not defined.  Again, GNU Emacs uses EMACS_TERM
  83. and Eunice uses TERM.)
  84.  
  85. NOTE: One performance aspect of termcap files is that they are
  86. searched sequentially, so you may want to move the most frequently
  87. used terminals at your site to the beginning of the file to minimize
  88. startup overhead.
  89.  
  90.         +---------------------------------------+
  91.         +    TERMINAL INITIALIZATION FILE    |
  92.         +---------------------------------------+
  93.  
  94. The termcap terminal driver allows you to initialize MG differently,
  95. depending on what kind of terminal you're using.  See
  96. [.SYS.DEFAULT]README for more information.
  97.  
  98.         +---------------------------------------+
  99.         |        INVOKING MG        |
  100.         +---------------------------------------+
  101.  
  102. First of all, remember to set up the logical names for the terminal
  103. type and termcap file.  This can be done just once, in your LOGIN.COM file.
  104.  
  105. Then, to just run MG in your current process,
  106.     $ RUN [emacs-directory]MG
  107.  
  108. Or you can define a symbol to run it with command line arguments:
  109.     $ MG :== $dev:[emacs-directory]MG
  110.     $ MG [file]
  111.  
  112.         +---------------------------------------+
  113.         |              MG As a Kept Fork        |
  114.         +---------------------------------------+
  115.  
  116. You can use [.SYS.VMS]MG.COM to spawn a MicroEmacs subjob, which you
  117. can then attach to and pop out of as you please. Edit the line at the
  118. top of MG.COM that defines the path to the image MG.EXE, then define a
  119. global symbol called MG:
  120.  
  121.     $ MG :== @dev:[emacs-directory.SYS.VMS]MG
  122.  
  123. You can then use MG to edit files:
  124.  
  125.     $ MG [file]
  126.  
  127. When inside MG, use the command M-x suspend-emacs (bound to C-z by
  128. default) to suspend the MG process and attach your terminal to the
  129. process that spawned it. To re-attach to MG, just issue the MG command
  130. again:
  131.  
  132.     $ MG [file]
  133.  
  134. The command file will reattach you to your MG process, where you can
  135. continue editing where you left off. If you specify a new file to
  136. edit, the command file sets a logical name which MG then looks at when
  137. you reattach.
  138.  
  139.  
  140.         +-------------------------------+
  141.         |     MG As a Mail Editor    |
  142.         +-------------------------------+
  143.  
  144. As an added bonus, the file MGMAILEDIT.COM makes MG your mail editor
  145. when you use the SEND/EDIT command.  Issue the command
  146.  
  147.     DEFINE/JOB MAIL$EDIT dev:[dir]MGMAILEDIT.COM
  148.  
  149. to inform the mail system you want to use MGMAILEDIT.COM, then whenever
  150. you issue SEND/EDIT inside mail, MG will be used as your mail editor.
  151.